ListDatabasesRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.redshiftdataapi.model.ListDatabasesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListDatabasesRequest
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

ListDatabasesRequest()

Constructors
Constructor and Description
`ListDatabasesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListDatabasesRequest`	`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`	`getDatabase()` The name of the database.
`String`	`getDbUser()` The database user name.
`Integer`	`getMaxResults()` The maximum number of databases 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`	`getSecretArn()` The name or ARN of the secret that enables access to the database.
`String`	`getWorkgroupName()` The serverless workgroup name.
`int`	`hashCode()`
`void`	`setClusterIdentifier(String clusterIdentifier)` The cluster identifier.
`void`	`setDatabase(String database)` The name of the database.
`void`	`setDbUser(String dbUser)` The database user name.
`void`	`setMaxResults(Integer maxResults)` The maximum number of databases 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`	`setSecretArn(String secretArn)` The name or ARN of the secret that enables access to the database.
`void`	`setWorkgroupName(String workgroupName)` The serverless workgroup name.
`String`	`toString()` Returns a string representation of this object.
`ListDatabasesRequest`	`withClusterIdentifier(String clusterIdentifier)` The cluster identifier.
`ListDatabasesRequest`	`withDatabase(String database)` The name of the database.
`ListDatabasesRequest`	`withDbUser(String dbUser)` The database user name.
`ListDatabasesRequest`	`withMaxResults(Integer maxResults)` The maximum number of databases to return in the response.
`ListDatabasesRequest`	`withNextToken(String nextToken)` A value that indicates the starting point for the next set of response records in a subsequent request.
`ListDatabasesRequest`	`withSecretArn(String secretArn)` The name or ARN of the secret that enables access to the database.
`ListDatabasesRequest`	`withWorkgroupName(String workgroupName)` The serverless workgroup name.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListDatabasesRequest
```
public ListDatabasesRequest()
```
- 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 ListDatabasesRequest 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.
  - setDatabase
```
public void setDatabase(String database)
```
    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
    
    Parameters:
    
    database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
  - getDatabase
```
public String getDatabase()
```
    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
    
    Returns:
    
    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
  - withDatabase
```
public ListDatabasesRequest withDatabase(String database)
```
    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
    
    Parameters:
    
    database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary 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 and authenticating using temporary credentials.
    
    Parameters:
    
    dbUser - The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
  - getDbUser
```
public String getDbUser()
```
    The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
    
    Returns:
    
    The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
  - withDbUser
```
public ListDatabasesRequest withDbUser(String dbUser)
```
    The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
    
    Parameters:
    
    dbUser - The database user name. This parameter is required when connecting to a cluster 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 databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
    
    Parameters:
    
    maxResults - The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
    
    Returns:
    
    The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
  - withMaxResults
```
public ListDatabasesRequest withMaxResults(Integer maxResults)
```
    The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
    
    Parameters:
    
    maxResults - The maximum number of databases to return in the response. If more databases 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 ListDatabasesRequest 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.
  - 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 ListDatabasesRequest 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.
  - setWorkgroupName
```
public void setWorkgroupName(String workgroupName)
```
    The serverless workgroup name. 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. 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. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
    
    Returns:
    
    The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
  - withWorkgroupName
```
public ListDatabasesRequest withWorkgroupName(String workgroupName)
```
    The serverless workgroup name. 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. 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 ListDatabasesRequest 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()

Did this page help you?

Class ListDatabasesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListDatabasesRequest

Method Detail

setClusterIdentifier

getClusterIdentifier

withClusterIdentifier

setDatabase

getDatabase

withDatabase

setDbUser

getDbUser

withDbUser

setMaxResults

getMaxResults

withMaxResults

setNextToken

getNextToken

withNextToken

setSecretArn

getSecretArn

withSecretArn

setWorkgroupName

getWorkgroupName

withWorkgroupName

toString

equals

hashCode

clone