Package software.amazon.awssdk.services.redshiftdata.model

Class DescribeTableRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest

software.amazon.awssdk.services.redshiftdata.model.DescribeTableRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTableRequest.Builder,DescribeTableRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeTableRequest
extends RedshiftDataRequest
implements ToCopyableBuilder<DescribeTableRequest.Builder,DescribeTableRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTableRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTableRequest.Builder	builder()
String	clusterIdentifier()	The cluster identifier.
String	connectedDatabase()	A database name.
String	database()	The name of the database that contains the tables to be described.
String	dbUser()	The database user name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of tables to return in the response.
String	nextToken()	A value that indicates the starting point for the next set of response records in a subsequent request.
String	schema()	The schema that contains the table.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretArn()	The name or ARN of the secret that enables access to the database.
static Class<? extends DescribeTableRequest.Builder>	serializableBuilderClass()
String	table()	The table name.
DescribeTableRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workgroupName()	The serverless workgroup name or Amazon Resource Name (ARN).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clusterIdentifier

public final String clusterIdentifier()

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Returns:

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

connectedDatabase

public final String connectedDatabase()

A database name. The connected database is specified when you connect with your authentication credentials.

Returns:

A database name. The connected database is specified when you connect with your authentication credentials.

database

public final String 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.

Returns:

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.

dbUser

public final String dbUser()

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Returns:

The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

maxResults

public final Integer 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.

Returns:

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.

nextToken

public final String 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.

Returns:

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.

schema

public final String schema()

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

Returns:

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

secretArn

public final String secretArn()

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Returns:

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

table

public final String 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

Returns:

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

workgroupName

public final String workgroupName()

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Returns:

The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

toBuilder

public DescribeTableRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTableRequest.Builder,DescribeTableRequest>

Specified by:

toBuilder in class RedshiftDataRequest

builder

public static DescribeTableRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeTableRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo