DataSource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.DataSource

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The structure of a data source.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataSource()

Constructors
Constructor and Description
`DataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSource`	`clone()`
`boolean`	`equals(Object obj)`
`List<DataSourceParameters>`	`getAlternateDataSourceParameters()` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`String`	`getArn()` The Amazon Resource Name (ARN) of the data source.
`Date`	`getCreatedTime()` The time that this data source was created.
`String`	`getDataSourceId()` The ID of the data source.
`DataSourceParameters`	`getDataSourceParameters()` The parameters that Amazon QuickSight uses to connect to your underlying source.
`DataSourceErrorInfo`	`getErrorInfo()` Error information from the last update or the creation of the data source.
`Date`	`getLastUpdatedTime()` The last time that this data source was updated.
`String`	`getName()` A display name for the data source.
`SslProperties`	`getSslProperties()` Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
`String`	`getStatus()` The HTTP status of the request.
`String`	`getType()` The type of the data source.
`VpcConnectionProperties`	`getVpcConnectionProperties()` The VPC connection information.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAlternateDataSourceParameters(Collection<DataSourceParameters> alternateDataSourceParameters)` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the data source.
`void`	`setCreatedTime(Date createdTime)` The time that this data source was created.
`void`	`setDataSourceId(String dataSourceId)` The ID of the data source.
`void`	`setDataSourceParameters(DataSourceParameters dataSourceParameters)` The parameters that Amazon QuickSight uses to connect to your underlying source.
`void`	`setErrorInfo(DataSourceErrorInfo errorInfo)` Error information from the last update or the creation of the data source.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The last time that this data source was updated.
`void`	`setName(String name)` A display name for the data source.
`void`	`setSslProperties(SslProperties sslProperties)` Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
`void`	`setStatus(String status)` The HTTP status of the request.
`void`	`setType(String type)` The type of the data source.
`void`	`setVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)` The VPC connection information.
`String`	`toString()` Returns a string representation of this object.
`DataSource`	`withAlternateDataSourceParameters(Collection<DataSourceParameters> alternateDataSourceParameters)` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`DataSource`	`withAlternateDataSourceParameters(DataSourceParameters... alternateDataSourceParameters)` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`DataSource`	`withArn(String arn)` The Amazon Resource Name (ARN) of the data source.
`DataSource`	`withCreatedTime(Date createdTime)` The time that this data source was created.
`DataSource`	`withDataSourceId(String dataSourceId)` The ID of the data source.
`DataSource`	`withDataSourceParameters(DataSourceParameters dataSourceParameters)` The parameters that Amazon QuickSight uses to connect to your underlying source.
`DataSource`	`withErrorInfo(DataSourceErrorInfo errorInfo)` Error information from the last update or the creation of the data source.
`DataSource`	`withLastUpdatedTime(Date lastUpdatedTime)` The last time that this data source was updated.
`DataSource`	`withName(String name)` A display name for the data source.
`DataSource`	`withSslProperties(SslProperties sslProperties)` Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
`DataSource`	`withStatus(ResourceStatus status)` The HTTP status of the request.
`DataSource`	`withStatus(String status)` The HTTP status of the request.
`DataSource`	`withType(DataSourceType type)` The type of the data source.
`DataSource`	`withType(String type)` The type of the data source.
`DataSource`	`withVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)` The VPC connection information.

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

- Constructor Detail
  - DataSource
```
public DataSource()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the data source.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the data source.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the data source.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the data source.
  - withArn
```
public DataSource withArn(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.
  - setDataSourceId
```
public void setDataSourceId(String dataSourceId)
```
    The ID of the data source. This ID is unique per AWS Region for each AWS account.
    
    Parameters:
    
    dataSourceId - The ID of the data source. This ID is unique per AWS Region for each AWS account.
  - getDataSourceId
```
public String getDataSourceId()
```
    The ID of the data source. This ID is unique per AWS Region for each AWS account.
    
    Returns:
    
    The ID of the data source. This ID is unique per AWS Region for each AWS account.
  - withDataSourceId
```
public DataSource withDataSourceId(String dataSourceId)
```
    The ID of the data source. This ID is unique per AWS Region for each AWS account.
    
    Parameters:
    
    dataSourceId - The ID of the data source. This ID is unique per AWS Region for each AWS account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A display name for the data source.
    
    Parameters:
    
    name - A display name for the data source.
  - getName
```
public String getName()
```
    A display name for the data source.
    
    Returns:
    
    A display name for the data source.
  - withName
```
public DataSource withName(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.
  - setType
```
public void setType(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.
    
    See Also:
    
    DataSourceType
  - getType
```
public String getType()
```
    The type of the data source. This type indicates which database engine the data source connects to.
    
    Returns:
    
    The type of the data source. This type indicates which database engine the data source connects to.
    
    See Also:
    
    DataSourceType
  - withType
```
public DataSource withType(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
  - withType
```
public DataSource withType(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
  - setStatus
```
public void setStatus(String status)
```
    The HTTP status of the request.
    
    Parameters:
    
    status - The HTTP status of the request.
    
    See Also:
    
    ResourceStatus
  - getStatus
```
public String getStatus()
```
    The HTTP status of the request.
    
    Returns:
    
    The HTTP status of the request.
    
    See Also:
    
    ResourceStatus
  - withStatus
```
public DataSource withStatus(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
  - withStatus
```
public DataSource withStatus(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
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The time that this data source was created.
    
    Parameters:
    
    createdTime - The time that this data source was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The time that this data source was created.
    
    Returns:
    
    The time that this data source was created.
  - withCreatedTime
```
public DataSource withCreatedTime(Date 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.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The last time that this data source was updated.
    
    Parameters:
    
    lastUpdatedTime - The last time that this data source was updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The last time that this data source was updated.
    
    Returns:
    
    The last time that this data source was updated.
  - withLastUpdatedTime
```
public DataSource withLastUpdatedTime(Date 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.
  - setDataSourceParameters
```
public void setDataSourceParameters(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.
  - getDataSourceParameters
```
public DataSourceParameters getDataSourceParameters()
```
    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:
    
    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.
  - withDataSourceParameters
```
public DataSource withDataSourceParameters(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.
  - getAlternateDataSourceParameters
```
public List<DataSourceParameters> getAlternateDataSourceParameters()
```
    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:
    
    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.
  - setAlternateDataSourceParameters
```
public void setAlternateDataSourceParameters(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.
  - withAlternateDataSourceParameters
```
public DataSource withAlternateDataSourceParameters(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAlternateDataSourceParameters(java.util.Collection) or withAlternateDataSourceParameters(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAlternateDataSourceParameters
```
public DataSource withAlternateDataSourceParameters(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.
  - setVpcConnectionProperties
```
public void setVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)
```
    The VPC connection information. You need to use this parameter only when you want 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 QuickSight to use a VPC connection when connecting to your underlying source.
  - getVpcConnectionProperties
```
public VpcConnectionProperties getVpcConnectionProperties()
```
    The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
    
    Returns:
    
    The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
  - withVpcConnectionProperties
```
public DataSource withVpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)
```
    The VPC connection information. You need to use this parameter only when you want 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 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.
  - setSslProperties
```
public void setSslProperties(SslProperties sslProperties)
```
    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
    
    Parameters:
    
    sslProperties - Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
  - getSslProperties
```
public SslProperties getSslProperties()
```
    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
    
    Returns:
    
    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
  - withSslProperties
```
public DataSource withSslProperties(SslProperties sslProperties)
```
    Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
    
    Parameters:
    
    sslProperties - Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorInfo
```
public void setErrorInfo(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.
  - getErrorInfo
```
public DataSourceErrorInfo getErrorInfo()
```
    Error information from the last update or the creation of the data source.
    
    Returns:
    
    Error information from the last update or the creation of the data source.
  - withErrorInfo
```
public DataSource withErrorInfo(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.
  - 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 DataSource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DataSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSource

Method Detail

setArn

getArn

withArn

setDataSourceId

getDataSourceId

withDataSourceId

setName

getName

withName

setType

getType

withType

withType

setStatus

getStatus

withStatus

withStatus

setCreatedTime

getCreatedTime

withCreatedTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setDataSourceParameters

getDataSourceParameters

withDataSourceParameters

getAlternateDataSourceParameters

setAlternateDataSourceParameters

withAlternateDataSourceParameters

withAlternateDataSourceParameters

setVpcConnectionProperties

getVpcConnectionProperties

withVpcConnectionProperties

setSslProperties

getSslProperties

withSslProperties

setErrorInfo

getErrorInfo

withErrorInfo

toString

equals

hashCode

clone

marshall