software.amazon.awssdk.services.translate.model.GetTerminologyRequest Maven / Gradle / Ivy
Show all versions of translate 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.translate.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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 GetTerminologyRequest extends TranslateRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(GetTerminologyRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField TERMINOLOGY_DATA_FORMAT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TerminologyDataFormat").getter(getter(GetTerminologyRequest::terminologyDataFormatAsString))
.setter(setter(Builder::terminologyDataFormat))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TerminologyDataFormat").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
TERMINOLOGY_DATA_FORMAT_FIELD));
private final String name;
private final String terminologyDataFormat;
private GetTerminologyRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.terminologyDataFormat = builder.terminologyDataFormat;
}
/**
*
* The name of the custom terminology being retrieved.
*
*
* @return The name of the custom terminology being retrieved.
*/
public final String name() {
return name;
}
/**
*
* The data format of the custom terminology being retrieved.
*
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was
* imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the
* same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #terminologyDataFormat} will return {@link TerminologyDataFormat#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #terminologyDataFormatAsString}.
*
*
* @return The data format of the custom terminology being retrieved.
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file
* that was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must
* specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate
* throws an error.
* @see TerminologyDataFormat
*/
public final TerminologyDataFormat terminologyDataFormat() {
return TerminologyDataFormat.fromValue(terminologyDataFormat);
}
/**
*
* The data format of the custom terminology being retrieved.
*
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was
* imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the
* same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #terminologyDataFormat} will return {@link TerminologyDataFormat#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #terminologyDataFormatAsString}.
*
*
* @return The data format of the custom terminology being retrieved.
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file
* that was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must
* specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate
* throws an error.
* @see TerminologyDataFormat
*/
public final String terminologyDataFormatAsString() {
return terminologyDataFormat;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(terminologyDataFormatAsString());
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 GetTerminologyRequest)) {
return false;
}
GetTerminologyRequest other = (GetTerminologyRequest) obj;
return Objects.equals(name(), other.name())
&& Objects.equals(terminologyDataFormatAsString(), other.terminologyDataFormatAsString());
}
/**
* 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("GetTerminologyRequest").add("Name", name())
.add("TerminologyDataFormat", terminologyDataFormatAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "TerminologyDataFormat":
return Optional.ofNullable(clazz.cast(terminologyDataFormatAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetTerminologyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TranslateRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the custom terminology being retrieved.
*
*
* @param name
* The name of the custom terminology being retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The data format of the custom terminology being retrieved.
*
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that
* was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify
* the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an
* error.
*
*
* @param terminologyDataFormat
* The data format of the custom terminology being retrieved.
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file
* that was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must
* specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate
* throws an error.
* @see TerminologyDataFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see TerminologyDataFormat
*/
Builder terminologyDataFormat(String terminologyDataFormat);
/**
*
* The data format of the custom terminology being retrieved.
*
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that
* was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify
* the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an
* error.
*
*
* @param terminologyDataFormat
* The data format of the custom terminology being retrieved.
*
* If you don't specify this parameter, Amazon Translate returns a file with the same format as the file
* that was imported to create the terminology.
*
*
* If you specify this parameter when you retrieve a multi-directional terminology resource, you must
* specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate
* throws an error.
* @see TerminologyDataFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see TerminologyDataFormat
*/
Builder terminologyDataFormat(TerminologyDataFormat terminologyDataFormat);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TranslateRequest.BuilderImpl implements Builder {
private String name;
private String terminologyDataFormat;
private BuilderImpl() {
}
private BuilderImpl(GetTerminologyRequest model) {
super(model);
name(model.name);
terminologyDataFormat(model.terminologyDataFormat);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getTerminologyDataFormat() {
return terminologyDataFormat;
}
public final void setTerminologyDataFormat(String terminologyDataFormat) {
this.terminologyDataFormat = terminologyDataFormat;
}
@Override
public final Builder terminologyDataFormat(String terminologyDataFormat) {
this.terminologyDataFormat = terminologyDataFormat;
return this;
}
@Override
public final Builder terminologyDataFormat(TerminologyDataFormat terminologyDataFormat) {
this.terminologyDataFormat(terminologyDataFormat == null ? null : terminologyDataFormat.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetTerminologyRequest build() {
return new GetTerminologyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}