com.amazonaws.services.redshiftdataapi.model

Class DescribeTableRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftdataapi.model.DescribeTableRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeTableRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeTableRequest()

Method Summary

Modifier and Type	Method and Description
DescribeTableRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClusterIdentifier() The cluster identifier.
String	getConnectedDatabase() A database name.
String	getDatabase() The name of the database that contains the tables to be described.
String	getDbUser() The database user name.
Integer	getMaxResults() The maximum number of tables to return in the response.
String	getNextToken() A value that indicates the starting point for the next set of response records in a subsequent request.
String	getSchema() The schema that contains the table.
String	getSecretArn() The name or ARN of the secret that enables access to the database.
String	getTable() The table name.
String	getWorkgroupName() The serverless workgroup name or Amazon Resource Name (ARN).
int	hashCode()
void	setClusterIdentifier(String clusterIdentifier) The cluster identifier.
void	setConnectedDatabase(String connectedDatabase) A database name.
void	setDatabase(String database) The name of the database that contains the tables to be described.
void	setDbUser(String dbUser) The database user name.
void	setMaxResults(Integer maxResults) The maximum number of tables to return in the response.
void	setNextToken(String nextToken) A value that indicates the starting point for the next set of response records in a subsequent request.
void	setSchema(String schema) The schema that contains the table.
void	setSecretArn(String secretArn) The name or ARN of the secret that enables access to the database.
void	setTable(String table) The table name.
void	setWorkgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).
String	toString() Returns a string representation of this object.
DescribeTableRequest	withClusterIdentifier(String clusterIdentifier) The cluster identifier.
DescribeTableRequest	withConnectedDatabase(String connectedDatabase) A database name.
DescribeTableRequest	withDatabase(String database) The name of the database that contains the tables to be described.
DescribeTableRequest	withDbUser(String dbUser) The database user name.
DescribeTableRequest	withMaxResults(Integer maxResults) The maximum number of tables to return in the response.
DescribeTableRequest	withNextToken(String nextToken) A value that indicates the starting point for the next set of response records in a subsequent request.
DescribeTableRequest	withSchema(String schema) The schema that contains the table.
DescribeTableRequest	withSecretArn(String secretArn) The name or ARN of the secret that enables access to the database.
DescribeTableRequest	withTable(String table) The table name.
DescribeTableRequest	withWorkgroupName(String workgroupName) The serverless workgroup name or Amazon Resource Name (ARN).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTableRequest

public DescribeTableRequest()

Method Detail

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

getClusterIdentifier

public String getClusterIdentifier()

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.

withClusterIdentifier

public DescribeTableRequest withClusterIdentifier(String clusterIdentifier)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setConnectedDatabase

public void setConnectedDatabase(String connectedDatabase)

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

Parameters:

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

getConnectedDatabase

public String getConnectedDatabase()

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.

withConnectedDatabase

public DescribeTableRequest withConnectedDatabase(String connectedDatabase)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDatabase

public void setDatabase(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.

Parameters:

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.

getDatabase

public String getDatabase()

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.

withDatabase

public DescribeTableRequest withDatabase(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDbUser

public void setDbUser(String dbUser)

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

Parameters:

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

getDbUser

public String getDbUser()

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.

withDbUser

public DescribeTableRequest withDbUser(String dbUser)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public DescribeTableRequest withMaxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public DescribeTableRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSchema

public void setSchema(String schema)

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

Parameters:

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

getSchema

public String getSchema()

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.

withSchema

public DescribeTableRequest withSchema(String schema)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecretArn

public void setSecretArn(String secretArn)

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

Parameters:

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

getSecretArn

public String getSecretArn()

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.

withSecretArn

public DescribeTableRequest withSecretArn(String secretArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTable

public void setTable(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

Parameters:

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

getTable

public String getTable()

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

withTable

public DescribeTableRequest withTable(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setWorkgroupName

public void setWorkgroupName(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.

Parameters:

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.

getWorkgroupName

public String getWorkgroupName()

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.

withWorkgroupName

public DescribeTableRequest withWorkgroupName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeTableRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()