DataSource (AWS Java SDK :: Services :: QuickSight 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.DataSource

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DataSource.Builder,DataSource>

@Generated(value="software.amazon.awssdk:codegen")
public final class DataSource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataSource.Builder,DataSource>

The structure of a data source.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DataSource.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DataSource.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DataSourceParameters>`	`alternateDataSourceParameters()` A set of alternate data source parameters that you want to share for the credentials stored with this data source.
`String`	`arn()` The Amazon Resource Name (ARN) of the data source.
`static DataSource.Builder`	`builder()`
`Instant`	`createdTime()` The time that this data source was created.
`String`	`dataSourceId()` The ID of the data source.
`DataSourceParameters`	`dataSourceParameters()` The parameters that Amazon QuickSight uses to connect to your underlying source.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`DataSourceErrorInfo`	`errorInfo()` Error information from the last update or the creation of the data source.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlternateDataSourceParameters()` For responses, this returns true if the service returned a value for the AlternateDataSourceParameters property.
`int`	`hashCode()`
`Instant`	`lastUpdatedTime()` The last time that this data source was updated.
`String`	`name()` A display name for the data source.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()` The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
`static Class<? extends DataSource.Builder>`	`serializableBuilderClass()`
`SslProperties`	`sslProperties()` Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
`ResourceStatus`	`status()` The HTTP status of the request.
`String`	`statusAsString()` The HTTP status of the request.
`DataSource.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataSourceType`	`type()` The type of the data source.
`String`	`typeAsString()` The type of the data source.
`VpcConnectionProperties`	`vpcConnectionProperties()` The VPC connection information.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the data source.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the data source.
  - dataSourceId
```
public final String dataSourceId()
```
    The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
    
    Returns:
    
    The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  - name
```
public final String name()
```
    A display name for the data source.
    
    Returns:
    
    A display name for the data source.
  - type
```
public final DataSourceType type()
```
    The type of the data source. This type indicates which database engine the data source connects to.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the data source. This type indicates which database engine the data source connects to.
    
    See Also:
    
    DataSourceType
  - typeAsString
```
public final String typeAsString()
```
    The type of the data source. This type indicates which database engine the data source connects to.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the data source. This type indicates which database engine the data source connects to.
    
    See Also:
    
    DataSourceType
  - status
```
public final ResourceStatus status()
```
    The HTTP status of the request.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The HTTP status of the request.
    
    See Also:
    
    ResourceStatus
  - statusAsString
```
public final String statusAsString()
```
    The HTTP status of the request.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ResourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The HTTP status of the request.
    
    See Also:
    
    ResourceStatus
  - createdTime
```
public final Instant createdTime()
```
    The time that this data source was created.
    
    Returns:
    
    The time that this data source was created.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    The last time that this data source was updated.
    
    Returns:
    
    The last time that this data source was updated.
  - dataSourceParameters
```
public final 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.
    
    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.
  - hasAlternateDataSourceParameters
```
public final boolean hasAlternateDataSourceParameters()
```
    For responses, this returns true if the service returned a value for the AlternateDataSourceParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - alternateDataSourceParameters
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlternateDataSourceParameters() method.
    
    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.
  - vpcConnectionProperties
```
public final 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.
    
    Returns:
    
    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.
  - sslProperties
```
public final SslProperties sslProperties()
```
    Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
    
    Returns:
    
    Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  - errorInfo
```
public final DataSourceErrorInfo errorInfo()
```
    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.
  - secretArn
```
public final String secretArn()
```
    The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
  - toBuilder
```
public DataSource.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DataSource.Builder,DataSource>
  - builder
```
public static DataSource.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DataSource.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DataSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

dataSourceId

name

type

typeAsString

status

statusAsString

createdTime

lastUpdatedTime

dataSourceParameters

hasAlternateDataSourceParameters

alternateDataSourceParameters

vpcConnectionProperties

sslProperties

errorInfo

secretArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields