software.amazon.awssdk.services.cloudsearch.model.AnalysisScheme Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch Show documentation
Show all versions of cloudsearch Show documentation
The AWS Java SDK for Amazon CloudSearch module holds the client classes that are used for communicating
with Amazon CloudSearch Service
/*
* 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.cloudsearch.model;
import java.beans.Transient;
import java.io.Serializable;
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.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;
/**
*
* Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language
* of the text to be processed. The following options can be configured for an analysis scheme: Synonyms,
* Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and
* AlgorithmicStemming.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AnalysisScheme implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ANALYSIS_SCHEME_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AnalysisSchemeName").getter(getter(AnalysisScheme::analysisSchemeName))
.setter(setter(Builder::analysisSchemeName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AnalysisSchemeName").build())
.build();
private static final SdkField ANALYSIS_SCHEME_LANGUAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AnalysisSchemeLanguage").getter(getter(AnalysisScheme::analysisSchemeLanguageAsString))
.setter(setter(Builder::analysisSchemeLanguage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AnalysisSchemeLanguage").build())
.build();
private static final SdkField ANALYSIS_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("AnalysisOptions")
.getter(getter(AnalysisScheme::analysisOptions)).setter(setter(Builder::analysisOptions))
.constructor(AnalysisOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AnalysisOptions").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ANALYSIS_SCHEME_NAME_FIELD,
ANALYSIS_SCHEME_LANGUAGE_FIELD, ANALYSIS_OPTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String analysisSchemeName;
private final String analysisSchemeLanguage;
private final AnalysisOptions analysisOptions;
private AnalysisScheme(BuilderImpl builder) {
this.analysisSchemeName = builder.analysisSchemeName;
this.analysisSchemeLanguage = builder.analysisSchemeLanguage;
this.analysisOptions = builder.analysisOptions;
}
/**
* Returns the value of the AnalysisSchemeName property for this object.
*
* @return The value of the AnalysisSchemeName property for this object.
*/
public final String analysisSchemeName() {
return analysisSchemeName;
}
/**
* Returns the value of the AnalysisSchemeLanguage property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #analysisSchemeLanguage} will return {@link AnalysisSchemeLanguage#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #analysisSchemeLanguageAsString}.
*
*
* @return The value of the AnalysisSchemeLanguage property for this object.
* @see AnalysisSchemeLanguage
*/
public final AnalysisSchemeLanguage analysisSchemeLanguage() {
return AnalysisSchemeLanguage.fromValue(analysisSchemeLanguage);
}
/**
* Returns the value of the AnalysisSchemeLanguage property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #analysisSchemeLanguage} will return {@link AnalysisSchemeLanguage#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #analysisSchemeLanguageAsString}.
*
*
* @return The value of the AnalysisSchemeLanguage property for this object.
* @see AnalysisSchemeLanguage
*/
public final String analysisSchemeLanguageAsString() {
return analysisSchemeLanguage;
}
/**
* Returns the value of the AnalysisOptions property for this object.
*
* @return The value of the AnalysisOptions property for this object.
*/
public final AnalysisOptions analysisOptions() {
return analysisOptions;
}
@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 + Objects.hashCode(analysisSchemeName());
hashCode = 31 * hashCode + Objects.hashCode(analysisSchemeLanguageAsString());
hashCode = 31 * hashCode + Objects.hashCode(analysisOptions());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AnalysisScheme)) {
return false;
}
AnalysisScheme other = (AnalysisScheme) obj;
return Objects.equals(analysisSchemeName(), other.analysisSchemeName())
&& Objects.equals(analysisSchemeLanguageAsString(), other.analysisSchemeLanguageAsString())
&& Objects.equals(analysisOptions(), other.analysisOptions());
}
/**
* 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("AnalysisScheme").add("AnalysisSchemeName", analysisSchemeName())
.add("AnalysisSchemeLanguage", analysisSchemeLanguageAsString()).add("AnalysisOptions", analysisOptions())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AnalysisSchemeName":
return Optional.ofNullable(clazz.cast(analysisSchemeName()));
case "AnalysisSchemeLanguage":
return Optional.ofNullable(clazz.cast(analysisSchemeLanguageAsString()));
case "AnalysisOptions":
return Optional.ofNullable(clazz.cast(analysisOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AnalysisScheme) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Sets the value of the AnalysisSchemeName property for this object.
*
* @param analysisSchemeName
* The new value for the AnalysisSchemeName property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder analysisSchemeName(String analysisSchemeName);
/**
* Sets the value of the AnalysisSchemeLanguage property for this object.
*
* @param analysisSchemeLanguage
* The new value for the AnalysisSchemeLanguage property for this object.
* @see AnalysisSchemeLanguage
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnalysisSchemeLanguage
*/
Builder analysisSchemeLanguage(String analysisSchemeLanguage);
/**
* Sets the value of the AnalysisSchemeLanguage property for this object.
*
* @param analysisSchemeLanguage
* The new value for the AnalysisSchemeLanguage property for this object.
* @see AnalysisSchemeLanguage
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnalysisSchemeLanguage
*/
Builder analysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage);
/**
* Sets the value of the AnalysisOptions property for this object.
*
* @param analysisOptions
* The new value for the AnalysisOptions property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder analysisOptions(AnalysisOptions analysisOptions);
/**
* Sets the value of the AnalysisOptions property for this object.
*
* This is a convenience that creates an instance of the {@link AnalysisOptions.Builder} avoiding the need to
* create one manually via {@link AnalysisOptions#builder()}.
*
* When the {@link Consumer} completes, {@link AnalysisOptions.Builder#build()} is called immediately and its
* result is passed to {@link #analysisOptions(AnalysisOptions)}.
*
* @param analysisOptions
* a consumer that will call methods on {@link AnalysisOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #analysisOptions(AnalysisOptions)
*/
default Builder analysisOptions(Consumer analysisOptions) {
return analysisOptions(AnalysisOptions.builder().applyMutation(analysisOptions).build());
}
}
static final class BuilderImpl implements Builder {
private String analysisSchemeName;
private String analysisSchemeLanguage;
private AnalysisOptions analysisOptions;
private BuilderImpl() {
}
private BuilderImpl(AnalysisScheme model) {
analysisSchemeName(model.analysisSchemeName);
analysisSchemeLanguage(model.analysisSchemeLanguage);
analysisOptions(model.analysisOptions);
}
public final String getAnalysisSchemeName() {
return analysisSchemeName;
}
public final void setAnalysisSchemeName(String analysisSchemeName) {
this.analysisSchemeName = analysisSchemeName;
}
@Override
@Transient
public final Builder analysisSchemeName(String analysisSchemeName) {
this.analysisSchemeName = analysisSchemeName;
return this;
}
public final String getAnalysisSchemeLanguage() {
return analysisSchemeLanguage;
}
public final void setAnalysisSchemeLanguage(String analysisSchemeLanguage) {
this.analysisSchemeLanguage = analysisSchemeLanguage;
}
@Override
@Transient
public final Builder analysisSchemeLanguage(String analysisSchemeLanguage) {
this.analysisSchemeLanguage = analysisSchemeLanguage;
return this;
}
@Override
@Transient
public final Builder analysisSchemeLanguage(AnalysisSchemeLanguage analysisSchemeLanguage) {
this.analysisSchemeLanguage(analysisSchemeLanguage == null ? null : analysisSchemeLanguage.toString());
return this;
}
public final AnalysisOptions.Builder getAnalysisOptions() {
return analysisOptions != null ? analysisOptions.toBuilder() : null;
}
public final void setAnalysisOptions(AnalysisOptions.BuilderImpl analysisOptions) {
this.analysisOptions = analysisOptions != null ? analysisOptions.build() : null;
}
@Override
@Transient
public final Builder analysisOptions(AnalysisOptions analysisOptions) {
this.analysisOptions = analysisOptions;
return this;
}
@Override
public AnalysisScheme build() {
return new AnalysisScheme(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy