software.amazon.awssdk.services.quicksight.model.CustomSql Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of quicksight Show documentation
Show all versions of quicksight Show documentation
The AWS Java SDK for QuickSight module holds the client classes that are used for
communicating with QuickSight.
/*
* 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.quicksight.model;
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;
/**
*
* A physical table type built from the results of the custom SQL query.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CustomSql implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DATA_SOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CustomSql::dataSourceArn)).setter(setter(Builder::dataSourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataSourceArn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CustomSql::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField SQL_QUERY_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CustomSql::sqlQuery)).setter(setter(Builder::sqlQuery))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SqlQuery").build()).build();
private static final SdkField> COLUMNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(CustomSql::columns))
.setter(setter(Builder::columns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Columns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(InputColumn::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DATA_SOURCE_ARN_FIELD,
NAME_FIELD, SQL_QUERY_FIELD, COLUMNS_FIELD));
private static final long serialVersionUID = 1L;
private final String dataSourceArn;
private final String name;
private final String sqlQuery;
private final List columns;
private CustomSql(BuilderImpl builder) {
this.dataSourceArn = builder.dataSourceArn;
this.name = builder.name;
this.sqlQuery = builder.sqlQuery;
this.columns = builder.columns;
}
/**
*
* The Amazon Resource Name (ARN) of the data source.
*
*
* @return The Amazon Resource Name (ARN) of the data source.
*/
public String dataSourceArn() {
return dataSourceArn;
}
/**
*
* A display name for the SQL query result.
*
*
* @return A display name for the SQL query result.
*/
public String name() {
return name;
}
/**
*
* The SQL query.
*
*
* @return The SQL query.
*/
public String sqlQuery() {
return sqlQuery;
}
/**
* Returns true if the Columns property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasColumns() {
return columns != null && !(columns instanceof SdkAutoConstructList);
}
/**
*
* The column schema from the SQL query result set.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasColumns()} to see if a value was sent in this field.
*
*
* @return The column schema from the SQL query result set.
*/
public List columns() {
return columns;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(dataSourceArn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(sqlQuery());
hashCode = 31 * hashCode + Objects.hashCode(columns());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CustomSql)) {
return false;
}
CustomSql other = (CustomSql) obj;
return Objects.equals(dataSourceArn(), other.dataSourceArn()) && Objects.equals(name(), other.name())
&& Objects.equals(sqlQuery(), other.sqlQuery()) && Objects.equals(columns(), other.columns());
}
/**
* 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 String toString() {
return ToString.builder("CustomSql").add("DataSourceArn", dataSourceArn()).add("Name", name())
.add("SqlQuery", sqlQuery()).add("Columns", columns()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DataSourceArn":
return Optional.ofNullable(clazz.cast(dataSourceArn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "SqlQuery":
return Optional.ofNullable(clazz.cast(sqlQuery()));
case "Columns":
return Optional.ofNullable(clazz.cast(columns()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CustomSql) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the data source.
*
*
* @param dataSourceArn
* The Amazon Resource Name (ARN) of the data source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataSourceArn(String dataSourceArn);
/**
*
* A display name for the SQL query result.
*
*
* @param name
* A display name for the SQL query result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The SQL query.
*
*
* @param sqlQuery
* The SQL query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sqlQuery(String sqlQuery);
/**
*
* The column schema from the SQL query result set.
*
*
* @param columns
* The column schema from the SQL query result set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columns(Collection columns);
/**
*
* The column schema from the SQL query result set.
*
*
* @param columns
* The column schema from the SQL query result set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columns(InputColumn... columns);
/**
*
* The column schema from the SQL query 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 #columns(List)}.
*
* @param columns
* 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 #columns(List)
*/
Builder columns(Consumer... columns);
}
static final class BuilderImpl implements Builder {
private String dataSourceArn;
private String name;
private String sqlQuery;
private List columns = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CustomSql model) {
dataSourceArn(model.dataSourceArn);
name(model.name);
sqlQuery(model.sqlQuery);
columns(model.columns);
}
public final String getDataSourceArn() {
return dataSourceArn;
}
@Override
public final Builder dataSourceArn(String dataSourceArn) {
this.dataSourceArn = dataSourceArn;
return this;
}
public final void setDataSourceArn(String dataSourceArn) {
this.dataSourceArn = dataSourceArn;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final String getSqlQuery() {
return sqlQuery;
}
@Override
public final Builder sqlQuery(String sqlQuery) {
this.sqlQuery = sqlQuery;
return this;
}
public final void setSqlQuery(String sqlQuery) {
this.sqlQuery = sqlQuery;
}
public final Collection getColumns() {
return columns != null ? columns.stream().map(InputColumn::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder columns(Collection columns) {
this.columns = InputColumnListCopier.copy(columns);
return this;
}
@Override
@SafeVarargs
public final Builder columns(InputColumn... columns) {
columns(Arrays.asList(columns));
return this;
}
@Override
@SafeVarargs
public final Builder columns(Consumer... columns) {
columns(Stream.of(columns).map(c -> InputColumn.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setColumns(Collection columns) {
this.columns = InputColumnListCopier.copyFromBuilder(columns);
}
@Override
public CustomSql build() {
return new CustomSql(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}