software.amazon.awssdk.services.rdsdata.model.ResultSetMetadata 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.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;
/**
*
* The metadata of the result set returned by a SQL statement.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResultSetMetadata implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField COLUMN_COUNT_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("columnCount").getter(getter(ResultSetMetadata::columnCount)).setter(setter(Builder::columnCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("columnCount").build()).build();
private static final SdkField> COLUMN_METADATA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("columnMetadata")
.getter(getter(ResultSetMetadata::columnMetadata))
.setter(setter(Builder::columnMetadata))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("columnMetadata").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ColumnMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLUMN_COUNT_FIELD,
COLUMN_METADATA_FIELD));
private static final long serialVersionUID = 1L;
private final Long columnCount;
private final List columnMetadata;
private ResultSetMetadata(BuilderImpl builder) {
this.columnCount = builder.columnCount;
this.columnMetadata = builder.columnMetadata;
}
/**
*
* The number of columns in the result set.
*
*
* @return The number of columns in the result set.
*/
public final Long columnCount() {
return columnCount;
}
/**
* For responses, this returns true if the service returned a value for the ColumnMetadata 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 hasColumnMetadata() {
return columnMetadata != null && !(columnMetadata instanceof SdkAutoConstructList);
}
/**
*
* The metadata of the columns in the result set.
*
*
* 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 #hasColumnMetadata} method.
*
*
* @return The metadata of the columns in the result set.
*/
public final List columnMetadata() {
return columnMetadata;
}
@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(columnCount());
hashCode = 31 * hashCode + Objects.hashCode(hasColumnMetadata() ? columnMetadata() : null);
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 ResultSetMetadata)) {
return false;
}
ResultSetMetadata other = (ResultSetMetadata) obj;
return Objects.equals(columnCount(), other.columnCount()) && hasColumnMetadata() == other.hasColumnMetadata()
&& Objects.equals(columnMetadata(), other.columnMetadata());
}
/**
* 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("ResultSetMetadata").add("ColumnCount", columnCount())
.add("ColumnMetadata", hasColumnMetadata() ? columnMetadata() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "columnCount":
return Optional.ofNullable(clazz.cast(columnCount()));
case "columnMetadata":
return Optional.ofNullable(clazz.cast(columnMetadata()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResultSetMetadata) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The number of columns in the result set.
*
*
* @param columnCount
* The number of columns in the result set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnCount(Long columnCount);
/**
*
* The metadata of the columns in the result set.
*
*
* @param columnMetadata
* The metadata of the columns in the result set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnMetadata(Collection columnMetadata);
/**
*
* The metadata of the columns in the result set.
*
*
* @param columnMetadata
* The metadata of the columns in the result set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnMetadata(ColumnMetadata... columnMetadata);
/**
*
* The metadata of the columns in the result set.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #columnMetadata(List)}.
*
* @param columnMetadata
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #columnMetadata(List)
*/
Builder columnMetadata(Consumer... columnMetadata);
}
static final class BuilderImpl implements Builder {
private Long columnCount;
private List columnMetadata = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ResultSetMetadata model) {
columnCount(model.columnCount);
columnMetadata(model.columnMetadata);
}
public final Long getColumnCount() {
return columnCount;
}
public final void setColumnCount(Long columnCount) {
this.columnCount = columnCount;
}
@Override
@Transient
public final Builder columnCount(Long columnCount) {
this.columnCount = columnCount;
return this;
}
public final List getColumnMetadata() {
List result = MetadataCopier.copyToBuilder(this.columnMetadata);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setColumnMetadata(Collection columnMetadata) {
this.columnMetadata = MetadataCopier.copyFromBuilder(columnMetadata);
}
@Override
@Transient
public final Builder columnMetadata(Collection columnMetadata) {
this.columnMetadata = MetadataCopier.copy(columnMetadata);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder columnMetadata(ColumnMetadata... columnMetadata) {
columnMetadata(Arrays.asList(columnMetadata));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder columnMetadata(Consumer... columnMetadata) {
columnMetadata(Stream.of(columnMetadata).map(c -> ColumnMetadata.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ResultSetMetadata build() {
return new ResultSetMetadata(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy