Class DataSource

java.lang.Object
software.amazon.awssdk.services.quicksight.model.DataSource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSource.Builder,DataSource>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 Quick Sight 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 Quick Sight 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 Quick Sight 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 Quick Sight to use a VPC connection when connecting to your underlying source.

    • sslProperties

      public final SslProperties sslProperties()

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

      Returns:
      Secure Socket Layer (SSL) properties that apply when Quick Sight 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataSource.Builder,DataSource>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.