software.amazon.awssdk.services.redshiftdata.model.DescribeTableRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redshiftdata Show documentation
Show all versions of redshiftdata Show documentation
The AWS Java SDK for Redshift Data module holds the client classes that are used for
communicating with Redshift Data.
/*
* 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.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.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeTableRequest extends RedshiftDataRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClusterIdentifier").getter(getter(DescribeTableRequest::clusterIdentifier))
.setter(setter(Builder::clusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterIdentifier").build()).build();
private static final SdkField CONNECTED_DATABASE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectedDatabase").getter(getter(DescribeTableRequest::connectedDatabase))
.setter(setter(Builder::connectedDatabase))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectedDatabase").build()).build();
private static final SdkField DATABASE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Database").getter(getter(DescribeTableRequest::database)).setter(setter(Builder::database))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Database").build()).build();
private static final SdkField DB_USER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("DbUser")
.getter(getter(DescribeTableRequest::dbUser)).setter(setter(Builder::dbUser))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DbUser").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeTableRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeTableRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField SCHEMA_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Schema")
.getter(getter(DescribeTableRequest::schema)).setter(setter(Builder::schema))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Schema").build()).build();
private static final SdkField SECRET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SecretArn").getter(getter(DescribeTableRequest::secretArn)).setter(setter(Builder::secretArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecretArn").build()).build();
private static final SdkField TABLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Table")
.getter(getter(DescribeTableRequest::table)).setter(setter(Builder::table))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Table").build()).build();
private static final SdkField WORKGROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WorkgroupName").getter(getter(DescribeTableRequest::workgroupName))
.setter(setter(Builder::workgroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkgroupName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_IDENTIFIER_FIELD,
CONNECTED_DATABASE_FIELD, DATABASE_FIELD, DB_USER_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, SCHEMA_FIELD,
SECRET_ARN_FIELD, TABLE_FIELD, WORKGROUP_NAME_FIELD));
private final String clusterIdentifier;
private final String connectedDatabase;
private final String database;
private final String dbUser;
private final Integer maxResults;
private final String nextToken;
private final String schema;
private final String secretArn;
private final String table;
private final String workgroupName;
private DescribeTableRequest(BuilderImpl builder) {
super(builder);
this.clusterIdentifier = builder.clusterIdentifier;
this.connectedDatabase = builder.connectedDatabase;
this.database = builder.database;
this.dbUser = builder.dbUser;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.schema = builder.schema;
this.secretArn = builder.secretArn;
this.table = builder.table;
this.workgroupName = builder.workgroupName;
}
/**
*
* The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either
* Secrets Manager or temporary credentials.
*
*
* @return The cluster identifier. This parameter is required when connecting to a cluster and authenticating using
* either Secrets Manager or temporary credentials.
*/
public final String clusterIdentifier() {
return clusterIdentifier;
}
/**
*
* A database name. The connected database is specified when you connect with your authentication credentials.
*
*
* @return A database name. The connected database is specified when you connect with your authentication
* credentials.
*/
public final String connectedDatabase() {
return connectedDatabase;
}
/**
*
* The name of the database that contains the tables to be described. If ConnectedDatabase is not
* specified, this is also the database to connect to with your authentication credentials.
*
*
* @return The name of the database that contains the tables to be described. If ConnectedDatabase is
* not specified, this is also the database to connect to with your authentication credentials.
*/
public final String database() {
return database;
}
/**
*
* The database user name. This parameter is required when connecting to a cluster and authenticating using
* temporary credentials.
*
*
* @return The database user name. This parameter is required when connecting to a cluster and authenticating using
* temporary credentials.
*/
public final String dbUser() {
return dbUser;
}
/**
*
* The maximum number of tables to return in the response. If more tables exist than fit in one response, then
* NextToken is returned to page through the results.
*
*
* @return The maximum number of tables to return in the response. If more tables exist than fit in one response,
* then NextToken is returned to page through the results.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* 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;
}
/**
*
* The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
*
*
* @return The schema that contains the table. If no schema is specified, then matching tables for all schemas are
* returned.
*/
public final String schema() {
return schema;
}
/**
*
* The name or ARN of the secret that enables access to the database. This parameter is required when authenticating
* using Secrets Manager.
*
*
* @return The name or ARN of the secret that enables access to the database. This parameter is required when
* authenticating using Secrets Manager.
*/
public final String secretArn() {
return secretArn;
}
/**
*
* The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and
* no schema is specified, then all tables for all schemas in the database are returned
*
*
* @return The table name. If no table is specified, then all tables for all matching schemas are returned. If no
* table and no schema is specified, then all tables for all schemas in the database are returned
*/
public final String table() {
return table;
}
/**
*
* The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and
* authenticating using either Secrets Manager or temporary credentials.
*
*
* @return The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and
* authenticating using either Secrets Manager or temporary credentials.
*/
public final String workgroupName() {
return workgroupName;
}
@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(clusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(connectedDatabase());
hashCode = 31 * hashCode + Objects.hashCode(database());
hashCode = 31 * hashCode + Objects.hashCode(dbUser());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(schema());
hashCode = 31 * hashCode + Objects.hashCode(secretArn());
hashCode = 31 * hashCode + Objects.hashCode(table());
hashCode = 31 * hashCode + Objects.hashCode(workgroupName());
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 DescribeTableRequest)) {
return false;
}
DescribeTableRequest other = (DescribeTableRequest) obj;
return Objects.equals(clusterIdentifier(), other.clusterIdentifier())
&& Objects.equals(connectedDatabase(), other.connectedDatabase()) && Objects.equals(database(), other.database())
&& Objects.equals(dbUser(), other.dbUser()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(schema(), other.schema())
&& Objects.equals(secretArn(), other.secretArn()) && Objects.equals(table(), other.table())
&& Objects.equals(workgroupName(), other.workgroupName());
}
/**
* 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("DescribeTableRequest").add("ClusterIdentifier", clusterIdentifier())
.add("ConnectedDatabase", connectedDatabase()).add("Database", database()).add("DbUser", dbUser())
.add("MaxResults", maxResults()).add("NextToken", nextToken()).add("Schema", schema())
.add("SecretArn", secretArn()).add("Table", table()).add("WorkgroupName", workgroupName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClusterIdentifier":
return Optional.ofNullable(clazz.cast(clusterIdentifier()));
case "ConnectedDatabase":
return Optional.ofNullable(clazz.cast(connectedDatabase()));
case "Database":
return Optional.ofNullable(clazz.cast(database()));
case "DbUser":
return Optional.ofNullable(clazz.cast(dbUser()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Schema":
return Optional.ofNullable(clazz.cast(schema()));
case "SecretArn":
return Optional.ofNullable(clazz.cast(secretArn()));
case "Table":
return Optional.ofNullable(clazz.cast(table()));
case "WorkgroupName":
return Optional.ofNullable(clazz.cast(workgroupName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeTableRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RedshiftDataRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The cluster identifier. This parameter is required when connecting to a cluster and authenticating using
* either Secrets Manager or temporary credentials.
*
*
* @param clusterIdentifier
* The cluster identifier. This parameter is required when connecting to a cluster and authenticating
* using either Secrets Manager or temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clusterIdentifier(String clusterIdentifier);
/**
*
* A database name. The connected database is specified when you connect with your authentication credentials.
*
*
* @param connectedDatabase
* A database name. The connected database is specified when you connect with your authentication
* credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectedDatabase(String connectedDatabase);
/**
*
* The name of the database that contains the tables to be described. If ConnectedDatabase is not
* specified, this is also the database to connect to with your authentication credentials.
*
*
* @param database
* The name of the database that contains the tables to be described. If ConnectedDatabase
* is not specified, this is also the database to connect to with your authentication credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder database(String database);
/**
*
* The database user name. This parameter is required when connecting to a cluster and authenticating using
* temporary credentials.
*
*
* @param dbUser
* The database user name. This parameter is required when connecting to a cluster and authenticating
* using temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbUser(String dbUser);
/**
*
* The maximum number of tables to return in the response. If more tables exist than fit in one response, then
* NextToken is returned to page through the results.
*
*
* @param maxResults
* The maximum number of tables to return in the response. If more tables exist than fit in one response,
* then NextToken is returned to page through the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* 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 schema that contains the table. If no schema is specified, then matching tables for all schemas are
* returned.
*
*
* @param schema
* The schema that contains the table. If no schema is specified, then matching tables for all schemas
* are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder schema(String schema);
/**
*
* The name or ARN of the secret that enables access to the database. This parameter is required when
* authenticating using Secrets Manager.
*
*
* @param secretArn
* The name or ARN of the secret that enables access to the database. This parameter is required when
* authenticating using Secrets Manager.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secretArn(String secretArn);
/**
*
* The table name. If no table is specified, then all tables for all matching schemas are returned. If no table
* and no schema is specified, then all tables for all schemas in the database are returned
*
*
* @param table
* The table name. If no table is specified, then all tables for all matching schemas are returned. If no
* table and no schema is specified, then all tables for all schemas in the database are returned
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder table(String table);
/**
*
* The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and
* authenticating using either Secrets Manager or temporary credentials.
*
*
* @param workgroupName
* The serverless workgroup name. This parameter is required when connecting to a serverless workgroup
* and authenticating using either Secrets Manager or temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workgroupName(String workgroupName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RedshiftDataRequest.BuilderImpl implements Builder {
private String clusterIdentifier;
private String connectedDatabase;
private String database;
private String dbUser;
private Integer maxResults;
private String nextToken;
private String schema;
private String secretArn;
private String table;
private String workgroupName;
private BuilderImpl() {
}
private BuilderImpl(DescribeTableRequest model) {
super(model);
clusterIdentifier(model.clusterIdentifier);
connectedDatabase(model.connectedDatabase);
database(model.database);
dbUser(model.dbUser);
maxResults(model.maxResults);
nextToken(model.nextToken);
schema(model.schema);
secretArn(model.secretArn);
table(model.table);
workgroupName(model.workgroupName);
}
public final String getClusterIdentifier() {
return clusterIdentifier;
}
public final void setClusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
}
@Override
public final Builder clusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
return this;
}
public final String getConnectedDatabase() {
return connectedDatabase;
}
public final void setConnectedDatabase(String connectedDatabase) {
this.connectedDatabase = connectedDatabase;
}
@Override
public final Builder connectedDatabase(String connectedDatabase) {
this.connectedDatabase = connectedDatabase;
return this;
}
public final String getDatabase() {
return database;
}
public final void setDatabase(String database) {
this.database = database;
}
@Override
public final Builder database(String database) {
this.database = database;
return this;
}
public final String getDbUser() {
return dbUser;
}
public final void setDbUser(String dbUser) {
this.dbUser = dbUser;
}
@Override
public final Builder dbUser(String dbUser) {
this.dbUser = dbUser;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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 String getSchema() {
return schema;
}
public final void setSchema(String schema) {
this.schema = schema;
}
@Override
public final Builder schema(String schema) {
this.schema = schema;
return this;
}
public final String getSecretArn() {
return secretArn;
}
public final void setSecretArn(String secretArn) {
this.secretArn = secretArn;
}
@Override
public final Builder secretArn(String secretArn) {
this.secretArn = secretArn;
return this;
}
public final String getTable() {
return table;
}
public final void setTable(String table) {
this.table = table;
}
@Override
public final Builder table(String table) {
this.table = table;
return this;
}
public final String getWorkgroupName() {
return workgroupName;
}
public final void setWorkgroupName(String workgroupName) {
this.workgroupName = workgroupName;
}
@Override
public final Builder workgroupName(String workgroupName) {
this.workgroupName = workgroupName;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeTableRequest build() {
return new DescribeTableRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy