Class ListSchemasRequest

    • 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 schemas to list. 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 schemas to list. 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 schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.

        Returns:
        The maximum number of schemas to return in the response. If more schemas 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.
      • schemaPattern

        public final String schemaPattern()

        A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.

        Returns:
        A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern 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.
      • 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.
      • 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