software.amazon.awssdk.services.redshiftdata.model.GetStatementResultResponse 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.redshiftdata.model;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetStatementResultResponse extends RedshiftDataResponse implements
ToCopyableBuilder {
private static final SdkField> COLUMN_METADATA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ColumnMetadata")
.getter(getter(GetStatementResultResponse::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 SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetStatementResultResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField>> RECORDS_FIELD = SdkField
.>> builder(MarshallingType.LIST)
.memberName("Records")
.getter(getter(GetStatementResultResponse::records))
.setter(setter(Builder::records))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Records").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Field::builder)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final SdkField TOTAL_NUM_ROWS_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("TotalNumRows").getter(getter(GetStatementResultResponse::totalNumRows))
.setter(setter(Builder::totalNumRows))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TotalNumRows").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLUMN_METADATA_FIELD,
NEXT_TOKEN_FIELD, RECORDS_FIELD, TOTAL_NUM_ROWS_FIELD));
private final List columnMetadata;
private final String nextToken;
private final List> records;
private final Long totalNumRows;
private GetStatementResultResponse(BuilderImpl builder) {
super(builder);
this.columnMetadata = builder.columnMetadata;
this.nextToken = builder.nextToken;
this.records = builder.records;
this.totalNumRows = builder.totalNumRows;
}
/**
* 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 properties (metadata) of a column.
*
*
* 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 properties (metadata) of a column.
*/
public final List columnMetadata() {
return columnMetadata;
}
/**
*
* A value that indicates the starting point for the next set of response records in a subsequent request. If a
* value is returned in a response, you can retrieve the next set of records by providing this returned NextToken
* value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response
* records have been retrieved for the request.
*
*
* @return A value that indicates the starting point for the next set of response records in a subsequent request.
* If a value is returned in a response, you can retrieve the next set of records by providing this returned
* NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is
* empty, all response records have been retrieved for the request.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Records 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 hasRecords() {
return records != null && !(records instanceof SdkAutoConstructList);
}
/**
*
* The results of the SQL statement.
*
*
* 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 #hasRecords} method.
*
*
* @return The results of the SQL statement.
*/
public final List> records() {
return records;
}
/**
*
* The total number of rows in the result set returned from a query. You can use this number to estimate the number
* of calls to the GetStatementResult operation needed to page through the results.
*
*
* @return The total number of rows in the result set returned from a query. You can use this number to estimate the
* number of calls to the GetStatementResult operation needed to page through the results.
*/
public final Long totalNumRows() {
return totalNumRows;
}
@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(hasColumnMetadata() ? columnMetadata() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasRecords() ? records() : null);
hashCode = 31 * hashCode + Objects.hashCode(totalNumRows());
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 GetStatementResultResponse)) {
return false;
}
GetStatementResultResponse other = (GetStatementResultResponse) obj;
return hasColumnMetadata() == other.hasColumnMetadata() && Objects.equals(columnMetadata(), other.columnMetadata())
&& Objects.equals(nextToken(), other.nextToken()) && hasRecords() == other.hasRecords()
&& Objects.equals(records(), other.records()) && Objects.equals(totalNumRows(), other.totalNumRows());
}
/**
* 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("GetStatementResultResponse")
.add("ColumnMetadata", hasColumnMetadata() ? columnMetadata() : null).add("NextToken", nextToken())
.add("Records", hasRecords() ? records() : null).add("TotalNumRows", totalNumRows()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ColumnMetadata":
return Optional.ofNullable(clazz.cast(columnMetadata()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Records":
return Optional.ofNullable(clazz.cast(records()));
case "TotalNumRows":
return Optional.ofNullable(clazz.cast(totalNumRows()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetStatementResultResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RedshiftDataResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The properties (metadata) of a column.
*
*
* @param columnMetadata
* The properties (metadata) of a column.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnMetadata(Collection columnMetadata);
/**
*
* The properties (metadata) of a column.
*
*
* @param columnMetadata
* The properties (metadata) of a column.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnMetadata(ColumnMetadata... columnMetadata);
/**
*
* The properties (metadata) of a column.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.redshiftdata.model.ColumnMetadata.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.redshiftdata.model.ColumnMetadata#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.redshiftdata.model.ColumnMetadata.Builder#build()} is called
* immediately and its result is passed to {@link #columnMetadata(List)}.
*
* @param columnMetadata
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.redshiftdata.model.ColumnMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #columnMetadata(java.util.Collection)
*/
Builder columnMetadata(Consumer... columnMetadata);
/**
*
* A value that indicates the starting point for the next set of response records in a subsequent request. If a
* value is returned in a response, you can retrieve the next set of records by providing this returned
* NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty,
* all response records have been retrieved for the request.
*
*
* @param nextToken
* A value that indicates the starting point for the next set of response records in a subsequent
* request. If a value is returned in a response, you can retrieve the next set of records by providing
* this returned NextToken value in the next NextToken parameter and retrying the command. If the
* NextToken field is empty, all response records have been retrieved for the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The results of the SQL statement.
*
*
* @param records
* The results of the SQL statement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder records(Collection> records);
/**
*
* The results of the SQL statement.
*
*
* @param records
* The results of the SQL statement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder records(Collection... records);
/**
*
* The total number of rows in the result set returned from a query. You can use this number to estimate the
* number of calls to the GetStatementResult operation needed to page through the results.
*
*
* @param totalNumRows
* The total number of rows in the result set returned from a query. You can use this number to estimate
* the number of calls to the GetStatementResult operation needed to page through the
* results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder totalNumRows(Long totalNumRows);
}
static final class BuilderImpl extends RedshiftDataResponse.BuilderImpl implements Builder {
private List columnMetadata = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private List> records = DefaultSdkAutoConstructList.getInstance();
private Long totalNumRows;
private BuilderImpl() {
}
private BuilderImpl(GetStatementResultResponse model) {
super(model);
columnMetadata(model.columnMetadata);
nextToken(model.nextToken);
records(model.records);
totalNumRows(model.totalNumRows);
}
public final List getColumnMetadata() {
List result = ColumnMetadataListCopier.copyToBuilder(this.columnMetadata);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setColumnMetadata(Collection columnMetadata) {
this.columnMetadata = ColumnMetadataListCopier.copyFromBuilder(columnMetadata);
}
@Override
public final Builder columnMetadata(Collection columnMetadata) {
this.columnMetadata = ColumnMetadataListCopier.copy(columnMetadata);
return this;
}
@Override
@SafeVarargs
public final Builder columnMetadata(ColumnMetadata... columnMetadata) {
columnMetadata(Arrays.asList(columnMetadata));
return this;
}
@Override
@SafeVarargs
public final Builder columnMetadata(Consumer... columnMetadata) {
columnMetadata(Stream.of(columnMetadata).map(c -> ColumnMetadata.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final List> getRecords() {
List> result = SqlRecordsCopier.copyToBuilder(this.records);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRecords(Collection> records) {
this.records = SqlRecordsCopier.copyFromBuilder(records);
}
@Override
public final Builder records(Collection> records) {
this.records = SqlRecordsCopier.copy(records);
return this;
}
@Override
@SafeVarargs
public final Builder records(Collection... records) {
records(Arrays.asList(records));
return this;
}
public final Long getTotalNumRows() {
return totalNumRows;
}
public final void setTotalNumRows(Long totalNumRows) {
this.totalNumRows = totalNumRows;
}
@Override
public final Builder totalNumRows(Long totalNumRows) {
this.totalNumRows = totalNumRows;
return this;
}
@Override
public GetStatementResultResponse build() {
return new GetStatementResultResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}