software.amazon.awssdk.services.rdsdata.model.ResultSetOptions Maven / Gradle / Ivy
/*
* 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.rdsdata.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.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;
/**
*
* Options that control how the result set is returned.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResultSetOptions implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DECIMAL_RETURN_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("decimalReturnType").getter(getter(ResultSetOptions::decimalReturnTypeAsString))
.setter(setter(Builder::decimalReturnType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("decimalReturnType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DECIMAL_RETURN_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String decimalReturnType;
private ResultSetOptions(BuilderImpl builder) {
this.decimalReturnType = builder.decimalReturnType;
}
/**
*
* A value that indicates how a field of DECIMAL type is represented in the response. The value of
* STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double
* value otherwise.
*
*
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to
* String, especially when working with currency values.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #decimalReturnType}
* will return {@link DecimalReturnType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #decimalReturnTypeAsString}.
*
*
* @return A value that indicates how a field of DECIMAL type is represented in the response. The value
* of STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a
* Double value otherwise.
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting
* to String, especially when working with currency values.
*
* @see DecimalReturnType
*/
public final DecimalReturnType decimalReturnType() {
return DecimalReturnType.fromValue(decimalReturnType);
}
/**
*
* A value that indicates how a field of DECIMAL type is represented in the response. The value of
* STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double
* value otherwise.
*
*
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to
* String, especially when working with currency values.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #decimalReturnType}
* will return {@link DecimalReturnType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #decimalReturnTypeAsString}.
*
*
* @return A value that indicates how a field of DECIMAL type is represented in the response. The value
* of STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a
* Double value otherwise.
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting
* to String, especially when working with currency values.
*
* @see DecimalReturnType
*/
public final String decimalReturnTypeAsString() {
return decimalReturnType;
}
@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(decimalReturnTypeAsString());
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 ResultSetOptions)) {
return false;
}
ResultSetOptions other = (ResultSetOptions) obj;
return Objects.equals(decimalReturnTypeAsString(), other.decimalReturnTypeAsString());
}
/**
* 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("ResultSetOptions").add("DecimalReturnType", decimalReturnTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "decimalReturnType":
return Optional.ofNullable(clazz.cast(decimalReturnTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResultSetOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A value that indicates how a field of DECIMAL type is represented in the response. The value of
* STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double
* value otherwise.
*
*
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to
* String, especially when working with currency values.
*
*
*
* @param decimalReturnType
* A value that indicates how a field of DECIMAL type is represented in the response. The
* value of STRING, the default, specifies that it is converted to a String value. The value
* of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to
* a Double value otherwise.
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend
* converting to String, especially when working with currency values.
*
* @see DecimalReturnType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DecimalReturnType
*/
Builder decimalReturnType(String decimalReturnType);
/**
*
* A value that indicates how a field of DECIMAL type is represented in the response. The value of
* STRING, the default, specifies that it is converted to a String value. The value of
* DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double
* value otherwise.
*
*
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to
* String, especially when working with currency values.
*
*
*
* @param decimalReturnType
* A value that indicates how a field of DECIMAL type is represented in the response. The
* value of STRING, the default, specifies that it is converted to a String value. The value
* of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to
* a Double value otherwise.
*
* Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend
* converting to String, especially when working with currency values.
*
* @see DecimalReturnType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DecimalReturnType
*/
Builder decimalReturnType(DecimalReturnType decimalReturnType);
}
static final class BuilderImpl implements Builder {
private String decimalReturnType;
private BuilderImpl() {
}
private BuilderImpl(ResultSetOptions model) {
decimalReturnType(model.decimalReturnType);
}
public final String getDecimalReturnType() {
return decimalReturnType;
}
public final void setDecimalReturnType(String decimalReturnType) {
this.decimalReturnType = decimalReturnType;
}
@Override
@Transient
public final Builder decimalReturnType(String decimalReturnType) {
this.decimalReturnType = decimalReturnType;
return this;
}
@Override
@Transient
public final Builder decimalReturnType(DecimalReturnType decimalReturnType) {
this.decimalReturnType(decimalReturnType == null ? null : decimalReturnType.toString());
return this;
}
@Override
public ResultSetOptions build() {
return new ResultSetOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}