DataSource (AWS Java SDK :: Services :: QuickSight 2.13.44 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
`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)`
`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()`
`static Class<? extends DataSource.Builder>`	`serializableBuilderClass()`
`SslProperties`	`sslProperties()` Secure Socket Layer (SSL) properties that apply when 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 String arn()
```
    The Amazon Resource Name (ARN) of the data source.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the data source.
  - dataSourceId
```
public String dataSourceId()
```
    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.
  - name
```
public String name()
```
    A display name for the data source.
    
    Returns:
    
    A display name for the data source.
  - type
```
public 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 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 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 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 Instant createdTime()
```
    The time that this data source was created.
    
    Returns:
    
    The time that this data source was created.
  - lastUpdatedTime
```
public Instant lastUpdatedTime()
```
    The last time that this data source was updated.
    
    Returns:
    
    The last time that this data source was updated.
  - dataSourceParameters
```
public 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.
  - vpcConnectionProperties
```
public 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.
    
    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.
  - sslProperties
```
public SslProperties sslProperties()
```
    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.
  - errorInfo
```
public 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.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

vpcConnectionProperties

sslProperties

errorInfo

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields