software.amazon.awssdk.services.quicksight.model

Interface DataSource.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DataSource.Builder,DataSource>, SdkBuilder<DataSource.Builder,DataSource>, SdkPojo

Enclosing class:

DataSource

public static interface DataSource.Builder
extends SdkPojo, CopyableBuilder<DataSource.Builder,DataSource>

Method Summary

Modifier and Type	Method and Description
DataSource.Builder	alternateDataSourceParameters(Collection<DataSourceParameters> alternateDataSourceParameters) A set of alternate data source parameters that you want to share for the credentials stored with this data source.
DataSource.Builder	alternateDataSourceParameters(Consumer<DataSourceParameters.Builder>... alternateDataSourceParameters) A set of alternate data source parameters that you want to share for the credentials stored with this data source.
DataSource.Builder	alternateDataSourceParameters(DataSourceParameters... alternateDataSourceParameters) A set of alternate data source parameters that you want to share for the credentials stored with this data source.
DataSource.Builder	arn(String arn) The Amazon Resource Name (ARN) of the data source.
DataSource.Builder	createdTime(Instant createdTime) The time that this data source was created.
DataSource.Builder	dataSourceId(String dataSourceId) The ID of the data source.
default DataSource.Builder	dataSourceParameters(Consumer<DataSourceParameters.Builder> dataSourceParameters) The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSource.Builder	dataSourceParameters(DataSourceParameters dataSourceParameters) The parameters that Amazon QuickSight uses to connect to your underlying source.
default DataSource.Builder	errorInfo(Consumer<DataSourceErrorInfo.Builder> errorInfo) Error information from the last update or the creation of the data source.
DataSource.Builder	errorInfo(DataSourceErrorInfo errorInfo) Error information from the last update or the creation of the data source.
DataSource.Builder	lastUpdatedTime(Instant lastUpdatedTime) The last time that this data source was updated.
DataSource.Builder	name(String name) A display name for the data source.
default DataSource.Builder	sslProperties(Consumer<SslProperties.Builder> sslProperties) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DataSource.Builder	sslProperties(SslProperties sslProperties) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DataSource.Builder	status(ResourceStatus status) The HTTP status of the request.
DataSource.Builder	status(String status) The HTTP status of the request.
DataSource.Builder	type(DataSourceType type) The type of the data source.
DataSource.Builder	type(String type) The type of the data source.
default DataSource.Builder	vpcConnectionProperties(Consumer<VpcConnectionProperties.Builder> vpcConnectionProperties) The VPC connection information.
DataSource.Builder	vpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties) The VPC connection information.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

DataSource.Builder arn(String arn)

The Amazon Resource Name (ARN) of the data source.

Parameters:

arn - The Amazon Resource Name (ARN) of the data source.

Returns:

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

dataSourceId

DataSource.Builder dataSourceId(String dataSourceId)

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Parameters:

dataSourceId - The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

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

name

DataSource.Builder name(String name)

A display name for the data source.

Parameters:

name - A display name for the data source.

Returns:

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

type

DataSource.Builder type(String type)

The type of the data source. This type indicates which database engine the data source connects to.

Parameters:

type - The type of the data source. This type indicates which database engine the data source connects to.

Returns:

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

See Also:

DataSourceType, DataSourceType

type

DataSource.Builder type(DataSourceType type)

The type of the data source. This type indicates which database engine the data source connects to.

Parameters:

type - The type of the data source. This type indicates which database engine the data source connects to.

Returns:

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

See Also:

DataSourceType, DataSourceType

status

DataSource.Builder status(String status)

The HTTP status of the request.

Parameters:

status - The HTTP status of the request.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

status

DataSource.Builder status(ResourceStatus status)

The HTTP status of the request.

Parameters:

status - The HTTP status of the request.

Returns:

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

See Also:

ResourceStatus, ResourceStatus

createdTime

DataSource.Builder createdTime(Instant createdTime)

The time that this data source was created.

Parameters:

createdTime - The time that this data source was created.

Returns:

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

lastUpdatedTime

DataSource.Builder lastUpdatedTime(Instant lastUpdatedTime)

The last time that this data source was updated.

Parameters:

lastUpdatedTime - The last time that this data source was updated.

Returns:

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

dataSourceParameters

DataSource.Builder dataSourceParameters(DataSourceParameters dataSourceParameters)

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Parameters:

dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Returns:

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

dataSourceParameters

default DataSource.Builder dataSourceParameters(Consumer<DataSourceParameters.Builder> dataSourceParameters)

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

This is a convenience method that creates an instance of the DataSourceParameters.Builder avoiding the need to create one manually via DataSourceParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSourceParameters(DataSourceParameters).

Parameters:

dataSourceParameters - a consumer that will call methods on DataSourceParameters.Builder

Returns:

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

See Also:

dataSourceParameters(DataSourceParameters)

alternateDataSourceParameters

DataSource.Builder alternateDataSourceParameters(Collection<DataSourceParameters> alternateDataSourceParameters)

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Parameters:

alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Returns:

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

alternateDataSourceParameters

DataSource.Builder alternateDataSourceParameters(DataSourceParameters... alternateDataSourceParameters)

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Parameters:

alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Returns:

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

alternateDataSourceParameters

DataSource.Builder alternateDataSourceParameters(Consumer<DataSourceParameters.Builder>... alternateDataSourceParameters)

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #alternateDataSourceParameters(List).

Parameters:

alternateDataSourceParameters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#alternateDataSourceParameters(List)

vpcConnectionProperties

DataSource.Builder vpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Parameters:

vpcConnectionProperties - The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Returns:

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

vpcConnectionProperties

default DataSource.Builder vpcConnectionProperties(Consumer<VpcConnectionProperties.Builder> vpcConnectionProperties)

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

This is a convenience method that creates an instance of the VpcConnectionProperties.Builder avoiding the need to create one manually via VpcConnectionProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConnectionProperties(VpcConnectionProperties).

Parameters:

vpcConnectionProperties - a consumer that will call methods on VpcConnectionProperties.Builder

Returns:

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

See Also:

vpcConnectionProperties(VpcConnectionProperties)

sslProperties

DataSource.Builder sslProperties(SslProperties sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Parameters:

sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Returns:

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

sslProperties

default DataSource.Builder sslProperties(Consumer<SslProperties.Builder> sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

This is a convenience method that creates an instance of the SslProperties.Builder avoiding the need to create one manually via SslProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sslProperties(SslProperties).

Parameters:

sslProperties - a consumer that will call methods on SslProperties.Builder

Returns:

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

See Also:

sslProperties(SslProperties)

errorInfo

DataSource.Builder errorInfo(DataSourceErrorInfo errorInfo)

Error information from the last update or the creation of the data source.

Parameters:

errorInfo - Error information from the last update or the creation of the data source.

Returns:

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

errorInfo

default DataSource.Builder errorInfo(Consumer<DataSourceErrorInfo.Builder> errorInfo)

Error information from the last update or the creation of the data source.

This is a convenience method that creates an instance of the DataSourceErrorInfo.Builder avoiding the need to create one manually via DataSourceErrorInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorInfo(DataSourceErrorInfo).

Parameters:

errorInfo - a consumer that will call methods on DataSourceErrorInfo.Builder

Returns:

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

See Also:

errorInfo(DataSourceErrorInfo)