Package software.amazon.awssdk.services.rds.model

Interface DescribeTenantDatabasesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeTenantDatabasesRequest.Builder,DescribeTenantDatabasesRequest>, RdsRequest.Builder, SdkBuilder<DescribeTenantDatabasesRequest.Builder,DescribeTenantDatabasesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeTenantDatabasesRequest

public static interface DescribeTenantDatabasesRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeTenantDatabasesRequest.Builder,DescribeTenantDatabasesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeTenantDatabasesRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier)	The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account.
DescribeTenantDatabasesRequest.Builder	filters(Collection<Filter> filters)	A filter that specifies one or more database tenants to describe.
DescribeTenantDatabasesRequest.Builder	filters(Consumer<Filter.Builder>... filters)	A filter that specifies one or more database tenants to describe.
DescribeTenantDatabasesRequest.Builder	filters(Filter... filters)	A filter that specifies one or more database tenants to describe.
DescribeTenantDatabasesRequest.Builder	marker(String marker)	An optional pagination token provided by a previous DescribeTenantDatabases request.
DescribeTenantDatabasesRequest.Builder	maxRecords(Integer maxRecords)	The maximum number of records to include in the response.
DescribeTenantDatabasesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeTenantDatabasesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeTenantDatabasesRequest.Builder	tenantDBName(String tenantDBName)	The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

dbInstanceIdentifier

DescribeTenantDatabasesRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.

Parameters:

dbInstanceIdentifier - The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.

Returns:

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

tenantDBName

DescribeTenantDatabasesRequest.Builder tenantDBName(String tenantDBName)

The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

Parameters:

tenantDBName - The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

Returns:

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

filters

DescribeTenantDatabasesRequest.Builder filters(Collection<Filter> filters)

A filter that specifies one or more database tenants to describe.

Supported filters:

• tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

• tenant-database-resource-id - Tenant database resource identifiers.

• dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

Parameters:

filters - A filter that specifies one or more database tenants to describe.

Supported filters:

• tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

• tenant-database-resource-id - Tenant database resource identifiers.

• dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

Returns:

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

filters

DescribeTenantDatabasesRequest.Builder filters(Filter... filters)

A filter that specifies one or more database tenants to describe.

Supported filters:

• tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

• tenant-database-resource-id - Tenant database resource identifiers.

• dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

Parameters:

filters - A filter that specifies one or more database tenants to describe.

Supported filters:

• tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

• tenant-database-resource-id - Tenant database resource identifiers.

• dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

Returns:

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

filters

DescribeTenantDatabasesRequest.Builder filters(Consumer<Filter.Builder>... filters)

A filter that specifies one or more database tenants to describe.

Supported filters:

• tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

• tenant-database-resource-id - Tenant database resource identifiers.

• dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

marker

DescribeTenantDatabasesRequest.Builder marker(String marker)

An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous DescribeTenantDatabases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

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

maxRecords

DescribeTenantDatabasesRequest.Builder maxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Returns:

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

overrideConfiguration

DescribeTenantDatabasesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeTenantDatabasesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder